home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / shell / ViNCEd.lha / ViNCEd / Include / ReadME < prev   
Encoding:
Text File  |  1998-09-12  |  3.7 KB  |  111 lines
  1. Hi folks!
  2. ____________________________________________________________________________
  3.  
  4. This directory contains the required files to develop tools for ViNCEd
  5. and the vnc.library. It's especially useful for program authors, mainly
  6. for the use of C compilers. Currently, these includes are only tested
  7. with the SAS/C compilers, they might require changes for other compilers.
  8. Especially, the link libraries will most likely work only with SAS/C.
  9.  
  10. This directory contains, too, the documentation, includes and examples
  11. for Massimo Tantignone's TBIClass boopsis which are used by ViNCEd if 
  12. available. Thanks a lot, Massimo, for allowing me to redistribute them!
  13.  
  14.  
  15. Here the contents of this directory, and where these files should go
  16. in a complete installation:
  17.  
  18. lib
  19.     Contains link libraries for easier access to vnc.library functions.
  20.     Even though the SAS/C "pragmas" work, it is recommended to use the
  21.     stub routines. More details are in the ReadMe in the "lib" 
  22.     directory.
  23.     Filese in here should be copied to the "lib" directory of your
  24.     compiler, to the other link libaries.
  25.  
  26. fd
  27.     Contains the "fd" function descriptor file for the vnc.library.
  28.     Should be copied to all your other "fd" files.
  29.  
  30. include_asm
  31.     Include files for the assembly language author. That's currently
  32.     not very much.
  33.  
  34. Examples
  35.     Example programs about some details and frequently asked questions
  36.     about ViNCEd and its API. These example programs have been 
  37.     successfully compiled with the SAS/C compiler, some changes might
  38.     be required for other compilers. Details are again in the ReadMe
  39.     in the "Examples" directory. If you want to keep them, copy them
  40.     to the sources directory of your C compiler.
  41.  
  42. proto
  43.     Prototypes for the vnc.library. The file in here includes the 
  44.     prototypes as well as the pragmas. If you include THIS file, you
  45.     will call the vnc.library directly, without the stub routines.
  46.     Should be copied to "INCLUDE:proto"
  47.  
  48. pragma
  49.     "pragma"s for direct calling of the library without stub routines.
  50.     Not recommended, even though this works. This file should be 
  51.     copied to "INCLUDE:pragma". It shouldn't be included directly.
  52.  
  53. clib
  54.     Prototypes for the functions of the vnc.library. MUST be included
  55.     as soon as you want to call any vnc.library functions, even if
  56.     you're using the stub routines of the link libraries.
  57.  
  58. vnc
  59.     This directory contains the include files for a C compiler.
  60.     The directory as a whole should be copied into "INCLUDE:vnc".
  61.     The files in here are as follows:
  62.  
  63.     vnc/dynamics.h
  64.         Dynamic memory management structures of ViNCEd.
  65.  
  66.     vnc/packets.h
  67.         Additional DOS PACKETS used by ViNCEd additionally to
  68.         those in dos/dosextens.h.
  69.  
  70.     vnc/macros.h
  71.         The structures for holding macros and buttons.
  72.  
  73.     vnc/keyboard.h
  74.         The structures for holding the extended, user configurable
  75.         keyboard as well as the IDs of the keyboard functions.
  76.  
  77.     vnc/owner.h
  78.         Structures for the "Owner" and "Named Console" machine of
  79.         ViNCEd. Required for job control functions.
  80.  
  81.     vnc/requester.h
  82.         Structures for the build-in file requester.
  83.  
  84.     vnc/vncbase.h
  85.         The structure of the library base.
  86.  
  87.     vnc/prefs.h
  88.         The structures holding the user preferences.
  89.  
  90.     vnc/io.h
  91.         buffered input/output functions in the vnc.library.
  92.  
  93.     vnc/window.h
  94.         defines the main structure of ViNCEd, the ViNCWindow,
  95.         as well as some secondary structures.
  96.  
  97.     images/titlebar.h
  98.         defines constants for the TBIClass, 
  99.         © 1998 Massimo Tantignone
  100.  
  101. Autodocs
  102.     This directory contains the autodocs for the vnc.library, i.e.
  103.     the documenation of the library functions. The autodocs come
  104.     only in plain ASCII version, but it is possible to convert
  105.     them to the AmigaGuide format if required. The necessary tools
  106.     to do this are not available in this archive.
  107.  
  108.     The TBIClass autodocs can be found here, too.
  109.  
  110. Thomas Richter.
  111.